![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@conventional-changelog/git-client
Advanced tools
Readme
Simple git client for conventional changelog packages.
# pnpm
pnpm add @conventional-changelog/git-client conventional-commits-filter conventional-commits-parser
# yarn
yarn add @conventional-changelog/git-client conventional-commits-filter conventional-commits-parser
# npm
npm i @conventional-changelog/git-client conventional-commits-filter conventional-commits-parser
Note: conventional-commits-filter
and conventional-commits-parser
are required only if you need ConventionalGitClient#getCommits
method.
import {
GitClient,
ConventionalGitClient
} from '@conventional-changelog/git-client'
// Basic git client
const client = new GitClient(process.cwd())
await client.add('package.json')
await client.commit({ message: 'chore: release v1.0.0' })
await client.tag({ name: 'v1.0.0' })
await client.push('master')
// Conventional git client, which extends basic git client
const conventionalClient = new ConventionalGitClient(process.cwd())
console.log(await conventionalClient.getVersionFromTags()) // v1.0.0
new GitClient(cwd: string)
Create a wrapper around git
CLI instance.
getRawCommits(params?: GitLogParams, restRawArgs?: string[]): AsyncIterable<string>
Get raw commits stream.
getTags(restRawArgs?: string[]): AsyncIterable<string>
Get tags stream.
checkIgnore(file: string, restRawArgs?: string[]): Promise<boolean>
Check file is ignored via .gitignore.
add(files: string | string[], restRawArgs?: string[]): Promise<void>
Add files to git index.
commit(params: GitCommitParams, restRawArgs?: string[]): Promise<void>
Commit changes.
tag(params: GitTagParams, restRawArgs?: string[]): Promise<void>
Create a tag for the current commit.
getCurrentBranch(restRawArgs?: string[]): Promise<string>
Get current branch name.
push(branch: string, restRawArgs?: string[]): Promise<void>
Push changes to remote.
new ConventionalGitClient(cwd: string)
Wrapper around Git CLI with conventional commits support.
getCommits(params?: ConventionalGitLogParams, parserOptions?: ParserStreamOptions, restRawArgs?: string[]): AsyncIterable<Commit>
Get parsed commits stream.
getSemverTags(params?: GitTagsLogParams, restRawArgs?: string[]): AsyncIterable<string>
Get semver tags stream.
getVersionFromTags(prefix?: string, restRawArgs?: string[]): Promise<string | null>
Get current sematic version from git tags.
MIT © Dan Onoshko
FAQs
Simple git client for conventional changelog packages.
The npm package @conventional-changelog/git-client receives a total of 34,908 weekly downloads. As such, @conventional-changelog/git-client popularity was classified as popular.
We found that @conventional-changelog/git-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.